Appliance Recovery Reconciliation Job Info

Appliance Recovery Reconciliation Job Info
Appliance Recovery Reconciliation Job Info

The Appliance Recovery Reconciliation Job Info schema represents the reconciliation job information. It contains information related to current Status, any associated messages and progress as percentage.

This schema was added in vSphere API 6.7.

JSON Example
{
    "description": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "service": "string",
    "operation": "string",
    "parent": "string",
    "target": {
        "type": "string",
        "id": "string"
    },
    "status": "string",
    "cancelable": false,
    "error": {},
    "start_time": "string",
    "end_time": "string",
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "progress": 0
}
description
Required

Description of the operation associated with the task.

This property was added in vSphere API 6.7.

string
service
Required

Name of the service containing the operation.

This property was added in vSphere API 6.7.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.

string
operation
Required

Name of the operation associated with the task.

This property was added in vSphere API 6.7.

string
parent
Optional

Parent of the current task.

This property was added in vSphere API 6.7.

This property will be missing or null if the task has no parent.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.

target
Optional

Identifier of the target resource the operation modifies.

This property was added in vSphere API 6.7.

This property will be missing or null if the task has multiple targets or no target.

string
status
Required

Status of the operation associated with the task.

For more information see: Appliance Recovery Reconciliation Job Status.

This property was added in vSphere API 6.7.

boolean
cancelable
Optional

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.

This property was added in vSphere API 6.7.

If missing or null, the operation cannot be canceled.

object
error
Optional

Description of the error if the operation status is "FAILED".

This property was added in vSphere API 6.7.

If missing or null the description of why the operation failed will be included in the result of the operation (see Info#result).

string As date-time As date-time
start_time
Optional

Time when the operation is started.

This property was added in vSphere API 6.7.

This property is optional and it is only relevant when the value of status is one of Appliance Recovery Reconciliation Job Status.RUNNING, Appliance Recovery Reconciliation Job Status.SUCCEEDED, or Appliance Recovery Reconciliation Job Status.FAILED.

string As date-time As date-time
end_time
Optional

Time when the operation is completed.

This property was added in vSphere API 6.7.

This property is optional and it is only relevant when the value of status is one of Appliance Recovery Reconciliation Job Status.SUCCEEDED or Appliance Recovery Reconciliation Job Status.FAILED.

array of Vapi Std LocalizableMessage
messages
Required

A list of localized messages.

This property was added in vSphere API 6.7.

integer As int64 As int64
progress
Required

The progress of the job as a percentage.

This property was added in vSphere API 6.7.

Returned By